-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add to UG command summary #191
Add to UG command summary #191
Conversation
Update Help Message to WedLinker's user guide. Update AB3 and AddressBook to reflect WedLinker. Update Jar File link. Update Ui example image. Update Quick Start guide to fit the target audience. Fix hyperlinks to accurately reflect its target.
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM -- left a few comments
|
||
1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. | ||
3. Copy the file to the folder you want to use as the _home folder_ for your WedLinker. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not necessary to change numbering as GFMD/MD helps do the auto numbering and this might make it more difficult for putting a point before this in the future
|
||
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br> | ||
4. Open WedLinker by double clicking the program file, `WedLinker.jar`.<br> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure whether for everyday users we are also encouraging double clicking to open
|
||
### Editing the data file | ||
|
||
AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. | ||
WedLinker data are saved automatically as a JSON file `[JAR file location]/data/WedLinker.json`. Advanced users are welcome to update data directly by editing that data file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we left it as addressbook.json
Builds on PR #170 so merge that first.
Adds wedding and task commands to command summary table in UG.